Pular para o conteúdo principal

Primeiros passos

Pré-requisitos para Integração​

A integração com as APIs da plataforma é um processo simples.

Nesta seção apresentamos os passos necessários para que parceiros e desenvolvedores possam iniciar a integração com segurança e eficiência.

1. Obtenha suas credenciais de acesso​

Após a formalização do contrato e o processo inicial de onboarding, serão disponibilizadas as credenciais necessárias para acesso às APIs.

Essas credenciais são utilizadas para autenticação das requisições e identificação da aplicação integradora.

Cada parceiro recebe credenciais exclusivas, que devem ser armazenadas de forma segura em um cofre de segredos ou sistema de gerenciamento de credenciais, evitando exposição em código-fonte ou ambientes públicos.

As credenciais são de uso exclusivo do parceiro e devem ser tratadas como informações sensíveis.

2. Utilize uma ferramenta para realizar requisições HTTP​

Para realizar testes e validar a integração com as APIs, recomenda-se a utilização de ferramentas que permitam executar requisições HTTP.

Algumas ferramentas amplamente utilizadas são:

  • Postman
  • Insomnia

Essas ferramentas permitem:

  • montar requisições HTTP
  • enviar payloads JSON
  • testar autenticação
  • validar respostas da API
  • simular fluxos de integração

Para entender melhor os ambientes disponíveis para testes e homologação, consulte a seção Ambientes de Sandbox e Produção.

3. Configure a autenticação via mTLS​

A comunicação com as APIs utiliza autenticação mTLS (Mutual TLS), garantindo que tanto o cliente quanto o servidor sejam autenticados durante a conexão.

Para realizar a integração, será necessário:

  1. Gerar o certificado de cliente.
  2. Configurar o certificado nas requisições HTTP.
  3. Garantir que todas as chamadas à API sejam realizadas utilizando o certificado mTLS válido.

Essa configuração assegura:

  • autenticidade das aplicações integradoras
  • criptografia das comunicações
  • proteção contra interceptação de dados

A configuração completa está detalhada na seção: Autenticação e Autorização (mTLS)

Realize a integração com as APIs da plataforma​

Após a configuração das credenciais e da autenticação mTLS, a aplicação já estará apta a consumir as APIs disponíveis.

Cada produto possui uma seção específica nesta documentação, contendo:

  • descrição dos endpoints
  • parâmetros de requisição
  • exemplos de chamadas
  • estrutura das respostas
  • códigos de erro